home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_300 / 317_01 / g4tdecod.c < prev    next >
C/C++ Source or Header  |  1990-06-16  |  23KB  |  649 lines
  1. /*    $Id: g4tdecod.c 1.2 90/06/09 18:24:25 marking Exp $
  2.  *
  3.  NAME
  4.  *    g4tdecod.c -- decode group 4 data using tables
  5.  *
  6.  TYPE
  7.  *    C procedures
  8.  *
  9.  SYNOPSIS
  10.  *    char    g4i_initialize (short image_width, short image_length);
  11.  *    char    g4i_decode (void);
  12.  *
  13.  DESCRIPTION
  14.  *    In order to acquire data from the image and to return run lengths and
  15.  *    new line information, these routines invoke procedures provided by the
  16.  *    caller. These caller-provided procedures are invoked throught pointers
  17.  *    which have been stuffed by the caller with the procedure addresses.
  18.  *    To acquire a new data byte, g4i_decode () calls (*p_g41_next_byte) ().
  19.  *    To report the decoding of a black or white run, the routines
  20.  *    (*p_decode_black) () or (*p_decode_white) () are called.
  21.  *
  22.  RETURNS
  23.  *    Initialization always returns zero.
  24.  *
  25.  *    For decoding,
  26.  *        0    end of image reached
  27.  *        -1    on error (bad data)
  28.  *    The decode loop will be prematurely terminated if decode_return is
  29.  *    set to not zero, and the value of decode_return will be returned.
  30.  *    No code here does this, but it might be useful under certain
  31.  *    circumstances.
  32.  *
  33.  LEGAL
  34.  *    Copyright 1989, 1990 Michael P. Marking, Post Office Box 8039,
  35.  *    Scottsdale, Arizona 85252-8039. All rights reserved.
  36.  *
  37.  *    License is granted by the copyright holder to distribute and use this
  38.  *    code without payment of royalties or the necessity of notification as
  39.  *    long as this notice (all the text under "LEGAL") is included.
  40.  *
  41.  *    Reference: $Id: g4tdecod.c 1.2 90/06/09 18:24:25 marking Exp $
  42.  *
  43.  *    This program is offered without any warranty of any kind. It includes
  44.  *    no warranty of merchantability or fitness for any purpose. Testing and
  45.  *    suitability for any use are the sole responsibility of the user.
  46.  * 
  47.  HISTORY
  48.  *    $Log:    g4tdecod.c $
  49.  * Revision 1.2  90/06/09  18:24:25  marking
  50.  * clean up comments for release
  51.  * 
  52.  * Revision 1.1  89/06/30  17:00:00  marking
  53.  * Initial revision
  54.  * 
  55.  *
  56.  NOTES
  57.  *
  58.  PORTABILITY
  59.  *    Tested using Microsoft C 5.1. Some memory models may not work due to
  60.  *    the large decoding arrays.
  61.  *
  62.  *    There is a non-portable use of "global" variables in the file g3g4.h,
  63.  *    about which a minority of compilers will justifiably complain. Certain
  64.  *    variables are declared in g3g4.h without extern keywords. Strictly
  65.  *    speaking, they should be declared extern in all but one module, but
  66.  *    that would require complication of g3g4.h. If it gets past your
  67.  *    compiler and linker, you can probably ignore it.
  68.  *
  69.  SEE ALSO
  70.  *    g3tdecod.c -- decode group 3 image using tables
  71.  *    builddec.c -- build image decoding tables
  72.  *
  73.  INFORMATION
  74.  *    Although there is no support offered with this program, the author will
  75.  *    endeavor to correct errors. Updates will also be made available from
  76.  *    time to time.
  77.  *
  78.  *    Contact: Michael P. Marking, Post Office Box 8039, Scottsdale, Arizona
  79.  *    85252-8039 USA. Replies are not guaranteed to be swift. Beginning
  80.  *    July 1990, e-mail may be sent to uunet!ipel!marking.
  81.  *
  82.  *    Also beginning in July 1990, this code will be archived at the
  83.  *    ipel!phoenix BBS in file g3g4.zoo. The 24-hour telephone number
  84.  *    for 300/1200/2400 is (602)274-0462. When logging in, specify user
  85.  *    "public", system "bbs", and password "public".
  86.  *
  87.  *    This code is also available from the C Users Group in volume 317.
  88.  */
  89.  
  90. #include "g3g4.h"
  91.  
  92. /* #define TRACE 1 */
  93. #define TRACE_BEGIN 0
  94. #define TRACE_END 30000
  95.  
  96. /* implementation limits: Due to the sizes of arrays and variables, and not
  97.    due to any restrictions in the algorithm, the following limits exist:
  98.      maximum number of pixels per row: 65533
  99.      maximum number of rows per image: none
  100.      maximum or minimum k-factor: none
  101.      maximum number of runs per row: 16382 white, 16382 black
  102.    To increase (or decrease) these limits, it will be necessary to play with
  103.    array and variable sizes.  On segmented machines (such as the 8086), a
  104.    different memory model may be necessary.  The algorithm itself has no
  105.    limits on image size or complexity, and the stack requirements are in-
  106.    sensitive to changes in these limits or to image complexity. */
  107.  
  108. #define EVEN 0
  109. #define ODD 1
  110.  
  111. static short a0, a1, a2, b0, b1, b2, bit_number, code_byte;
  112. static unsigned char color, current_row, mode, next_state;
  113. static unsigned short even_runs [32768], odd_runs [32768];
  114. static unsigned short even_index, odd_index;
  115. static short column_limit;
  116. static short row_number = 0;
  117.   /* Depending as current_row == EVEN or current_row == ODD, the runs of the
  118.      current row are represented in even_runs [] or odd_runs [].  The white
  119.      runs have even subscripts and the black runs have odd subscripts.  The
  120.      values of the array elements are the offsets of the beginnings of the
  121.      corresponding runs from the beginning of the row.  As defined by the
  122.      specification,
  123.     a0 is the reference or starting changing element on the coding line.
  124.         It may be considered the "current position".
  125.     a1 is the next changing element to the right of a0 on the coding line.
  126.     a2 is the next changing element to the right of a1 on the coding line.
  127.     b1 is the first changing element on the reference line to the right of
  128.         a0 and of opposite color to a0.
  129.     b2 is the next changing element to the right of b1 on the reference
  130.         line.
  131.      Furthermore,
  132.     b0 is the "previous" value of b1. 
  133.      Depending as current_row == EVEN or == ODD, even_index or odd_index is
  134.      the subscript of the entry in even_runs [] or odd_runs [] corresponding
  135.      to the run containing the current value of a0, and its counterpart cor-
  136.      responds to the run containing b1. */
  137.  
  138. extern unsigned char huge null_mode [] [256];
  139.   /* One of the entries PASS_MODE, HORIZONTAL_MODE, etc, or zero.  If the entry
  140.      is zero, then the bit string is indigestible and null_mode_next_state [][]
  141.      is consulted to decode the subsequent byte.  The row number (first sub-
  142.      script) corresponds to the assumption about the state of the machine after
  143.      decoding the previous codeword.  If < 8, then it refers to the starting
  144.      bit number for this codeword.  If > 7, it implies a bit string to be pre-
  145.      fixed to the first bit of the current byte.  The column number (second
  146.      subscript) refers to the value of the current byte. */
  147.  
  148. extern unsigned char huge null_mode_next_state [] [256];
  149. extern unsigned char huge horiz_mode [] [256];
  150. extern unsigned char huge horiz_mode_next_state [] [256];
  151.  
  152. static void new_row (void);
  153. static short decode_white_run (void);
  154. static short decode_black_run (void);
  155.  
  156. static char decode_return;
  157.  
  158. /* g4i_decode () successively invokes (*p_decode_next_byte) () for each byte of the
  159.    encoded image, and calls (*p_decode_white) () or (*p_decode_black) () as
  160.    required to return the image contents on a run-by-run basis. */
  161. char g4i_decode ()
  162. {
  163.   /* At the beginning of this routine, we are in the NULL mode, which is to
  164.      to say that no codewords are currently understood or digested.  The
  165.      variable bit_number has been initialized to zero, to indicate that the
  166.      next (first) codeword is to begin with bit zero of the next code byte.
  167.      This betrays an assumption that all images begin on byte boundaries, a
  168.      condition that can be changed by arranging for bit_number to be set
  169.      otherwise by g4i_initialize () or elsewhere. */
  170.   while (!decode_return)
  171.   {
  172.     /* No codewords have been digested, so no mode is currently understood.
  173.        It is possible, however, that bits have been left over from the last
  174.        code byte, and that these must be conceptually prefixed to the next
  175.        bits at the beginning of the next code byte to establish which code
  176.        word is next.  The decision is made based on bit_number, which is
  177.        zero if the codeword begins on a byte boundary; 1, 2, ... 7 if the
  178.        codeword begins with bit 1, 2, ... 7; or > 7 if the codeword begins
  179.        with bit zero but is assumed to have a non-null bits string prefix.
  180.        In any case, the bit_number corresponds to a row in the decoding
  181.        tables. */
  182.     if (bit_number == 0 || bit_number > 7) /* the